/
ResultContext`1.xml
332 lines (332 loc) · 20.3 KB
/
ResultContext`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
<Type Name="ResultContext<TOptions>" FullName="Microsoft.AspNetCore.Authentication.ResultContext<TOptions>">
<TypeSignature Language="C++ CLI" Value="generic <typename TOptions>
 where TOptions : AuthenticationSchemeOptionspublic ref class ResultContext abstract : Microsoft::AspNetCore::Authentication::BaseContext<TOptions>" />
<TypeSignature Language="C#" Value="public abstract class ResultContext<TOptions> : Microsoft.AspNetCore.Authentication.BaseContext<TOptions> where TOptions : AuthenticationSchemeOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ResultContext`1<(class Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions) TOptions> extends Microsoft.AspNetCore.Authentication.BaseContext`1<!TOptions>" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Authentication.ResultContext`1" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ResultContext(Of TOptions)
Inherits BaseContext(Of TOptions)" />
<TypeSignature Language="F#" Value="type ResultContext<'Options (requires 'Options :> AuthenticationSchemeOptions)> = class
 inherit BaseContext<'Options (requires 'Options :> AuthenticationSchemeOptions)>" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TOptions">
<Constraints>
<BaseTypeName>Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions</BaseTypeName>
</Constraints>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>Microsoft.AspNetCore.Authentication.BaseContext<TOptions></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="TOptions">TOptions</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="TOptions">To be added.</typeparam>
<summary>
Base context for events that produce AuthenticateResults.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="protected:
 ResultContext(Microsoft::AspNetCore::Http::HttpContext ^ context, Microsoft::AspNetCore::Authentication::AuthenticationScheme ^ scheme, TOptions options);" />
<MemberSignature Language="C#" Value="protected ResultContext (Microsoft.AspNetCore.Http.HttpContext context, Microsoft.AspNetCore.Authentication.AuthenticationScheme scheme, TOptions options);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.AspNetCore.Http.HttpContext context, class Microsoft.AspNetCore.Authentication.AuthenticationScheme scheme, !TOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Authentication.ResultContext`1.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,`0)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (context As HttpContext, scheme As AuthenticationScheme, options As TOptions)" />
<MemberSignature Language="F#" Value="new Microsoft.AspNetCore.Authentication.ResultContext<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions)> : Microsoft.AspNetCore.Http.HttpContext * Microsoft.AspNetCore.Authentication.AuthenticationScheme * 'Options -> Microsoft.AspNetCore.Authentication.ResultContext<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions)>" Usage="new Microsoft.AspNetCore.Authentication.ResultContext<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions)> (context, scheme, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="context" Type="Microsoft.AspNetCore.Http.HttpContext" />
<Parameter Name="scheme" Type="Microsoft.AspNetCore.Authentication.AuthenticationScheme" />
<Parameter Name="options" Type="TOptions" />
</Parameters>
<Docs>
<param name="context">The context.</param>
<param name="scheme">The authentication scheme.</param>
<param name="options">The authentication options associated with the scheme.</param>
<summary>
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.ResultContext`1" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Fail">
<MemberSignature Language="C++ CLI" Value="public:
 void Fail(Exception ^ failure);" />
<MemberSignature Language="C#" Value="public void Fail (Exception failure);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Fail(class System.Exception failure) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Authentication.ResultContext`1.Fail(System.Exception)" />
<MemberSignature Language="VB.NET" Value="Public Sub Fail (failure As Exception)" />
<MemberSignature Language="F#" Value="member this.Fail : Exception -> unit" Usage="resultContext.Fail failure" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="failure" Type="System.Exception" />
</Parameters>
<Docs>
<param name="failure" />
<summary>
Indicates that there was a failure during authentication.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Fail">
<MemberSignature Language="C++ CLI" Value="public:
 void Fail(System::String ^ failureMessage);" />
<MemberSignature Language="C#" Value="public void Fail (string failureMessage);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Fail(string failureMessage) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Authentication.ResultContext`1.Fail(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Fail (failureMessage As String)" />
<MemberSignature Language="F#" Value="member this.Fail : string -> unit" Usage="resultContext.Fail failureMessage" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="failureMessage" Type="System.String" />
</Parameters>
<Docs>
<param name="failureMessage" />
<summary>
Indicates that there was a failure during authentication.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NoResult">
<MemberSignature Language="C++ CLI" Value="public:
 void NoResult();" />
<MemberSignature Language="C#" Value="public void NoResult ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void NoResult() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Authentication.ResultContext`1.NoResult" />
<MemberSignature Language="VB.NET" Value="Public Sub NoResult ()" />
<MemberSignature Language="F#" Value="member this.NoResult : unit -> unit" Usage="resultContext.NoResult " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Indicates that there was no information returned for this authentication scheme.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Principal">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Security::Claims::ClaimsPrincipal ^ Principal { System::Security::Claims::ClaimsPrincipal ^ get(); void set(System::Security::Claims::ClaimsPrincipal ^ value); };" />
<MemberSignature Language="C#" Value="public System.Security.Claims.ClaimsPrincipal Principal { get; set; }" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Claims.ClaimsPrincipal Principal" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Principal" />
<MemberSignature Language="VB.NET" Value="Public Property Principal As ClaimsPrincipal" />
<MemberSignature Language="F#" Value="member this.Principal : System.Security.Claims.ClaimsPrincipal with get, set" Usage="Microsoft.AspNetCore.Authentication.ResultContext<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions)>.Principal" />
<MemberSignature Language="C#" Value="public System.Security.Claims.ClaimsPrincipal? Principal { get; set; }" FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0">
<AttributeName Language="C#">[set: System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Security.Claims.ClaimsPrincipal</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="T:System.Security.Claims.ClaimsPrincipal" /> containing the user claims.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ Properties { Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ get(); void set(Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ value); };" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Authentication.AuthenticationProperties Properties { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Authentication.AuthenticationProperties Properties" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Properties" />
<MemberSignature Language="VB.NET" Value="Public Property Properties As AuthenticationProperties" />
<MemberSignature Language="F#" Value="member this.Properties : Microsoft.AspNetCore.Authentication.AuthenticationProperties with get, set" Usage="Microsoft.AspNetCore.Authentication.ResultContext<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions)>.Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Authentication.AuthenticationProperties</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Result">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::AspNetCore::Authentication::AuthenticateResult ^ Result { Microsoft::AspNetCore::Authentication::AuthenticateResult ^ get(); };" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Authentication.AuthenticateResult Result { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Authentication.AuthenticateResult Result" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Result" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Result As AuthenticateResult" />
<MemberSignature Language="F#" Value="member this.Result : Microsoft.AspNetCore.Authentication.AuthenticateResult" Usage="Microsoft.AspNetCore.Authentication.ResultContext<'Options (requires 'Options :> Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions)>.Result" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Authentication.AuthenticateResult</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult" /> result.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Success">
<MemberSignature Language="C++ CLI" Value="public:
 void Success();" />
<MemberSignature Language="C#" Value="public void Success ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Success() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Authentication.ResultContext`1.Success" />
<MemberSignature Language="VB.NET" Value="Public Sub Success ()" />
<MemberSignature Language="F#" Value="member this.Success : unit -> unit" Usage="resultContext.Success " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Calls success creating a ticket with the <see cref="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Principal" /> and <see cref="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Properties" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>